From 4127a267f19bc152e7d421c1363a204758fd29b3 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 9 Jan 2002 00:02:30 +0000 Subject: [PATCH] Speak of window IDs rather than XIDs in the docs. * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather than XIDs in the docs. * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. * gtk/tmpl/gtksocket.sgml, gtk/tmpl/gtkplug.sgml: speak of window IDs rather than XIDs. --- ChangeLog | 7 +++++++ ChangeLog.pre-2-0 | 7 +++++++ ChangeLog.pre-2-10 | 7 +++++++ ChangeLog.pre-2-2 | 7 +++++++ ChangeLog.pre-2-4 | 7 +++++++ ChangeLog.pre-2-6 | 7 +++++++ ChangeLog.pre-2-8 | 7 +++++++ docs/reference/ChangeLog | 5 +++++ docs/reference/gtk/tmpl/gtkplug.sgml | 15 ++++++++------- docs/reference/gtk/tmpl/gtksocket.sgml | 19 +++++++++---------- gtk/gtkclipboard.c | 3 ++- gtk/gtkplug.c | 4 ++-- gtk/gtksocket.c | 10 +++++----- 13 files changed, 80 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 04b7423838..c6e2a7828e 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,10 @@ +2002-01-08 Matthias Clasen + + * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather + than XIDs in the docs. + + * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs. + Tue Jan 8 18:39:23 2002 Jonathan Blandford * gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow! diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 98e0a0a8da..8b0f6c10b7 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2002-01-08 Matthias Clasen + + * gtk/tmpl/gtksocket.sgml, gtk/tmpl/gtkplug.sgml: speak of + window IDs rather than XIDs. + 2002-01-07 Matthias Clasen * gtk/tmpl/gtksocket.sgml: Mention gtk_socket_get_id() diff --git a/docs/reference/gtk/tmpl/gtkplug.sgml b/docs/reference/gtk/tmpl/gtkplug.sgml index a790952703..296c0b7341 100644 --- a/docs/reference/gtk/tmpl/gtkplug.sgml +++ b/docs/reference/gtk/tmpl/gtkplug.sgml @@ -10,8 +10,8 @@ Together with #GtkSocket, #GtkPlug provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a #GtkSocket widget and, passes the -XID of that widgets window to the other process, -which then creates a #GtkPlug window with that XID. +ID of that widgets window to the other process, +which then creates a #GtkPlug with that window ID. Any widgets contained in the #GtkPlug then will appear inside the first applications window. @@ -36,22 +36,23 @@ inside the first applications window. -Finish the creation of a #GtkPlug widget. This function +Finishes the creation of a #GtkPlug widget. This function will generally only be used by classes deriving from #GtkPlug. @plug: a #GtkPlug widget. -@socket_id: the XID of the socket's window. +@socket_id: the window ID of the socket. -Create a new plug widget inside the #GtkSocket identified -by @socket_id. +Creates a new plug widget inside the #GtkSocket identified +by @socket_id. If @socket_id is 0, the plug is left "unplugged" and +can later be plugged into a #GtkSocket by gtk_socket_add_id(). -@socket_id: the XID of the socket's window. +@socket_id: the window ID of the socket, or 0. @Returns: the new #GtkPlug widget. diff --git a/docs/reference/gtk/tmpl/gtksocket.sgml b/docs/reference/gtk/tmpl/gtksocket.sgml index dd654b95d2..dcfbe11a93 100644 --- a/docs/reference/gtk/tmpl/gtksocket.sgml +++ b/docs/reference/gtk/tmpl/gtksocket.sgml @@ -10,20 +10,20 @@ Together with #GtkPlug, #GtkSocket provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a #GtkSocket widget and, passes the -XID of that widget's window to the other process, -which then creates a #GtkPlug window with that XID. +that widget's window ID to the other process, +which then creates a #GtkPlug with that window ID. Any widgets contained in the #GtkPlug then will appear inside the first applications window. -The XID of the socket's window is obtained by using +The socket's window ID is obtained by using gtk_socket_get_id(). Before using this function, the socket must have been realized, and for hence, have been added to its parent. -Obtaining the XID of a socket. +Obtaining the window ID of a socket. GtkWidget *socket = gtk_socket_new (); gtk_widget_show (socket); @@ -33,14 +33,14 @@ gtk_container_add (GTK_CONTAINER (parent), socket); * the ancestors of the socket is not yet visible. */ gtk_widget_realize (socket); -g_print ("The XID of the sockets window is %#x\n", +g_print ("The ID of the sockets window is %#x\n", gtk_socket_get_id (socket)); -Note that if you pass the XID of the socket to another +Note that if you pass the window ID of the socket to another process that will create a plug in the socket, you must make sure that the socket widget is not destroyed until that plug is created. Violating this rule will @@ -82,13 +82,12 @@ as between a #GtkPlug and a #GtkSocket. -The #GtkSocket structure contains the following field. -(This field should be considered read-only. It should +The #GtkSocket structure contains the plug_window +field. (This field should be considered read-only. It should never be set by an application.) -@plug_window: -the window embedded inside this #GtkSocket. +@plug_window: the window embedded inside this #GtkSocket. diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c index b4dbba71fc..97d9ea9931 100644 --- a/gtk/gtkclipboard.c +++ b/gtk/gtkclipboard.c @@ -498,7 +498,8 @@ clipboard_unset (GtkClipboard *clipboard) * @clipboard: a #GtkClipboard * * Clears the contents of the clipboard. Generally this should only - * be called between the time you call gtk_clipboard_set_contents(), + * be called between the time you call gtk_clipboard_set_with_owner() + * or gtk_clipboard_set_with_data(), * and when the @clear_func you supplied is called. Otherwise, the * clipboard may be owned by someone else. **/ diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c index e8af9c5f05..74b4f2a12e 100644 --- a/gtk/gtkplug.c +++ b/gtk/gtkplug.c @@ -210,7 +210,7 @@ gtk_plug_set_is_child (GtkPlug *plug, * @plug: a #GtkPlug * @socket: a #GtkSocket * - * Add a plug to a socket within the same application. + * Adds a plug to a socket within the same application. **/ void _gtk_plug_add_to_socket (GtkPlug *plug, @@ -244,7 +244,7 @@ _gtk_plug_add_to_socket (GtkPlug *plug, * @plug: a #GtkPlug * @socket: a #GtkSocket * - * Remove a plug from a socket within the same application. + * Removes a plug from a socket within the same application. **/ void _gtk_plug_remove_from_socket (GtkPlug *plug, diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c index a4879c560f..6b33ddaa92 100644 --- a/gtk/gtksocket.c +++ b/gtk/gtksocket.c @@ -207,7 +207,7 @@ gtk_socket_new (void) /** * gtk_socket_steal: * @socket: a #GtkSocket - * @wid: the XID of an existing toplevel window. + * @wid: the window ID of an existing toplevel window. * * Reparents a pre-existing toplevel window into a #GtkSocket. This is * meant to embed clients that do not know about embedding into a @@ -232,14 +232,14 @@ gtk_socket_steal (GtkSocket *socket, GdkNativeWindow wid) /** * gtk_socket_add_id: * @socket: a #GtkSocket - * @window_id: the XID of a client participating in the XEMBED protocol. + * @window_id: the window ID of a client participating in the XEMBED protocol. * * Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The * client may be in the same process or in a different process. * * To embed a #GtkPlug in a #GtkSocket, you can either create the - * #GtkPlug with gtk_plug_new (0), call gtk_plug_get_id() to get the - * window ID of the plug, and then pass that to the + * #GtkPlug with gtk_plug_new (0), call + * gtk_plug_get_id() to get the window ID of the plug, and then pass that to the * gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the * window ID for the socket, and call gtk_plug_new() passing in that * ID. @@ -265,7 +265,7 @@ gtk_socket_add_id (GtkSocket *socket, GdkNativeWindow window_id) * * Gets the window ID of a #GtkSocket widget, which can then * be used to create a client embedded inside the socket, for - * instance with gtk_plug_new (). + * instance with gtk_plug_new(). * * The #GtkSocket must have already be added into a toplevel window * before you can make this call. -- 2.30.2